Changes between Initial Version and Version 1 of XmlRpcGetIMDBMovieDetails


Ignore:
Timestamp:
Oct 12, 2008, 5:02:14 PM (16 years ago)
Author:
majky
Comment:

Created this page

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcGetIMDBMovieDetails

    v1 v1  
     1
     2[[PageOutline(3-4, Sections)]]
     3
     4== GetIMDBMovieDetails ==
     5
     6=== Intro ===
     7
     8  get details about given movie
     9
     10
     11----
     12=== Description ===
     13
     14  '''struct GetIMDBMovieDetails(string $token, string $imdbid)'''
     15 
     16  Returns structure with movie information about given movie $imdbid containing movie title, release year, directors, cast, ...
     17 
     18  All information is gathered from [http://www.imdb.com IMDb].
     19
     20
     21----
     22=== Parameters ===
     23
     24{{{
     25struct(
     26  (string) [token],
     27  (string) [imdbid]
     28)
     29}}}
     30
     31  ''token (required)''::
     32    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] output structure.
     33  ''imdbid (required)''::
     34    IMDb ID of requested movie, can be taken from results of [wiki:XmlRpcSearchMoviesOnIMDB SearchMoviesOnIMDB()]
     35
     36
     37----
     38=== Return Values ===
     39
     40  Output is returned in this structure:
     41   
     42{{{
     43struct(
     44  (string) [status],
     45  struct(
     46    (string) [id],
     47    (string) [title],
     48    (string) [year],
     49    (string) [cover],
     50    struct(
     51      (string) [<id>], (string) [id], ...
     52    ) [cast],
     53    struct(
     54      (string) [<id>], (string) [id], ...
     55    ) [directors],
     56    struct(
     57      (string) [<id>], (string) [id], ...
     58    ) [writers],
     59    (string) [awards],
     60    array(
     61      (string) [genre], (string) [genre], ...
     62    ) [genres],
     63    array(
     64      (string) [country], (string) [country], ...
     65    ) [country],
     66    array(
     67      (string) [language], (string) [language], ...
     68    ) [language],
     69    (string) [duration],
     70    array(
     71      (string) [certification], (string) [certification], ...
     72    ) [certification],
     73    (string) [tagline],
     74    (string) [plot],
     75    (string) [goofs],
     76    (string) [trivia],
     77    (string) [request_from]
     78  ) [data],
     79  (double) [seconds]
     80)
     81}}}
     82
     83  and contains these elements:
     84    ''status''::
     85      function result code, see [wiki:XmlRpcStatusCode list of status codes]
     86    ''data''::
     87      structure containing movie information
     88    ''seconds''::
     89      time taken to execute this command on server
     90
     91
     92----
     93=== Implementations ===
     94
     95  There are currently no available sample implementations.
     96
     97
     98----
     99=== Changelog ===
     100
     101  Version 1: created this function
     102
     103
     104----
     105=== Examples ===
     106
     107
     108==== Input ====
     109 
     110{{{
     111#!xml
     112<methodCall>
     113 <methodName>GetIMDBMovieDetails</methodName>
     114 <params>
     115  <param>
     116   <value><string>d0iot4l0teqk9nmn3s99bdhsh3</string></value>
     117  </param>
     118  <param>
     119   <value><string>0088763</string></value>
     120  </param>
     121 </params>
     122</methodCall>
     123}}}
     124
     125 
     126==== Output ====
     127
     128This structure might be incomplete (or extended later).
     129
     130Not sure if these values are returned: rating, aka.
     131
     132{{{
     133#!xml
     134<methodResponse>
     135 <params>
     136  <param>
     137   <value>
     138    <struct>
     139     <member>
     140      <name>status</name>
     141      <value><string>200 OK</string></value>
     142     </member>
     143     <member>
     144      <name>data</name>
     145      <value>
     146       <struct>
     147        <member>
     148         <name>id</name>
     149         <value><string>0088763</string></value>
     150        </member>
     151        <member>
     152         <name>title</name>
     153         <value><string>Back to the Future</string></value>
     154        </member>
     155        <member>
     156         <name>year</name>
     157         <value><string>1985</string></value>
     158        </member>
     159        <member>
     160         <name>cover</name>
     161         <value><string>http://ia.media-imdb.com/images/M/MV5BMTkzNDQyMjc0OV5BMl5BanBnXkFtZTcwNDQ4MDYyMQ@@._V1._SX100_SY133_.jpg</string></value>
     162        </member>
     163        <member>
     164         <name>cast</name>
     165         <value>
     166          <struct>
     167           <member>
     168            <name>_0000150</name>
     169            <value><string>Michael J. Fox</string></value>
     170           </member>
     171           <member>
     172            <name>_0000502</name>
     173            <value><string>Christopher Lloyd</string></value>
     174           </member>
     175           <member>
     176            <name>_0000670</name>
     177            <value><string>Lea Thompson</string></value>
     178           </member>
     179           
     180           ... more cast members go here (if any) ...
     181           
     182          </struct>
     183         </value>
     184        </member>
     185        <member>
     186         <name>directors</name>
     187         <value>
     188          <struct>
     189           <member>
     190            <name>_0000709</name>
     191            <value><string>Robert Zemeckis</string></value>
     192           </member>
     193           
     194           ... more directors go here (if any) ...
     195           
     196          </struct>
     197         </value>
     198        </member>
     199        <member>
     200         <name>writers</name>
     201         <value>
     202          <struct>
     203           <member>
     204            <name>_0000709</name>
     205            <value><string>Robert Zemeckis</string></value>
     206           </member>
     207           <member>
     208            <name>_0301826</name>
     209            <value><string>Bob Gale</string></value>
     210           </member>
     211          </struct>
     212         </value>
     213        </member>
     214        <member>
     215         <name>awards</name>
     216         <value><string>Won Oscar. Another 12 wins &#38; 22 nominations</string></value>
     217        </member>
     218        <member>
     219         <name>genres</name>
     220         <value>
     221          <array>
     222           <data>
     223            <value><string>Adventure</string></value>
     224            <value><string>Comedy</string></value>
     225            <value><string>Sci-Fi</string></value>
     226           
     227            ... more genres go here (if any) ...
     228           
     229           </data>
     230          </array>
     231         </value>
     232        </member>
     233        <member>
     234         <name>country</name>
     235         <value>
     236          <array>
     237           <data>
     238            <value><string>USA</string></value>
     239           </data>
     240          </array>
     241         </value>
     242        </member>
     243        <member>
     244         <name>language</name>
     245         <value>
     246          <array>
     247           <data>
     248            <value><string>English</string></value>
     249           </data>
     250          </array>
     251         </value>
     252        </member>
     253        <member>
     254         <name>duration</name>
     255         <value><string>117 min</string></value>
     256        </member>
     257        <member>
     258         <name>certification</name>
     259         <value>
     260          <array>
     261           <data>
     262            <value><string>UK</string></value>
     263            <value><string>Italy</string></value>
     264            <value><string>Australia</string></value>
     265            <value><string>USA</string></value>
     266           </data>
     267          </array>
     268         </value>
     269        </member>
     270        <member>
     271         <name>tagline</name>
     272         <value><string>He's the only kid ever to get into trouble before he was born. [UK]</string></value>
     273        </member>
     274        <member>
     275         <name>plot</name>
     276         <value><string>In 1985, Doc Brown invented time travel, in 1955, Marty McFly accidentally prevented his parents from meeting, putting his own existence at stake.</string></value>
     277        </member>
     278        <member>
     279         <name>goofs</name>
     280         <value><string>Continuity: A picture on the table below Biff, and the candy in Biff's hand when he is talking to George about his car in 1985.</string></value>
     281        </member>
     282        <member>
     283         <name>trivia</name>
     284         <value><string>The space alien gag first appeared in the screenplay's third draft, with the primary difference being that it was to be done to Biff.</string></value>
     285        </member>
     286        <member>
     287         <name>request_from</name>
     288         <value><string>cache</string></value>
     289        </member>
     290       </struct>
     291      </value>
     292     </member>
     293     <member>
     294      <name>seconds</name>
     295      <value><double>0.535</double></value>
     296     </member>
     297    </struct>
     298   </value>
     299  </param>
     300 </params>
     301</methodResponse>
     302}}}
     303
     304
     305----
     306=== Notes ===
     307
     308  none yet
     309
     310
     311----
     312=== See also ===
     313
     314  * [wiki:XmlRpcSearchMoviesOnIMDB SearchMoviesOnIMDB()]
     315
     316
     317----
     318=== Comments ===
     319
     320        add your comments, hints and suggestions here if you like ...
     321
     322
     323--------
     324[Prev] [wiki:XmlRpcIntro Home] [Next]